Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: improve versioning documentation and add showcase example #163

Merged
merged 10 commits into from
May 24, 2024
Merged

fix: improve versioning documentation and add showcase example #163

merged 10 commits into from
May 24, 2024

Conversation

Xavier-Redondo
Copy link
Contributor

@Xavier-Redondo Xavier-Redondo commented May 23, 2024 •
edited
Loading

Pull Request Template

PR Checklist

  • I have run npm test locally and all tests are passing.
  • I have added/updated tests for any new behavior.
  • I have added/updated documentation for any new behavior.
  • If this is a significant change, an issue has already been created where the problem / solution was discussed: [N/A, or add link to issue here]

PR Description

No functional changes at all
This pr has two parts:

  • creation of a new example project that showcases how the api versioning works. I need this in order to make sure that any change applied due to ESM update does not break the versioning mechanism.
  • improve the current documentation to clearly specify what is required to make it work (previous documentation had an example without deprecated, and it did not clearly specify that deprecated was mandatory). I have slightly updated the examples to have them work.

Out of scope of this PR: Before there was no example with express and there is still no example of express. In fact i have removed the reference to it and a TBD due to our plans with it.

This closes #162

@Xavier-Redondo Xavier-Redondo requested a review from a team as a code owner May 23, 2024 16:02
@github-actions GitHub Actions
Copy link

github-actions bot commented May 23, 2024 •
edited
Loading

Dependency Review

The following issues were found:
  • ✅ 0 vulnerable package(s)
  • ✅ 0 package(s) with incompatible licenses
  • ✅ 0 package(s) with invalid SPDX license definitions
  • ⚠️ 4 package(s) with unknown licenses.
See the Details below.

License Issues

packages/bautajs-fastify-versioning-example/package.json

PackageVersionLicenseIssue Type
@axa/bautajs-core^3.1.0NullUnknown License
@axa/bautajs-datasource-rest^3.1.0NullUnknown License
@axa/bautajs-fastify^3.1.0NullUnknown License
fastify^4.15.0NullUnknown License
Denied Licenses: GPL-2.0+, AGPL-3.0-or-later, LGPL-2.0-or-later

Scanned Manifest Files

packages/bautajs-fastify-versioning-example/package.json
  • @axa/bautajs-core@^3.1.0
  • @axa/bautajs-datasource-rest@^3.1.0
  • @axa/bautajs-fastify@^3.1.0
  • fastify@^4.15.0

@Xavier-Redondo Xavier-Redondo changed the title Fix/add versioning examples fix: improve versioning documentation and add showcase example May 23, 2024
franher
franher requested changes May 23, 2024
View reviewed changes
Copy link
Contributor

@franher franher left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but please do not commit the changes outside the bautajs-fastify-versioning-example.

Thank you for your contribution :)

packages/bautajs-core/src/bauta.ts Outdated Show resolved Hide resolved
packages/bautajs-fastify/src/index.ts Outdated Show resolved Hide resolved
@franher franher merged commit 420bac9 into main May 24, 2024
11 of 12 checks passed
@franher franher deleted the fix/add-versioning-examples branch May 24, 2024 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@franher franher franher requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

improve versioning documentation and add an example to showcase it
2 participants
@Xavier-Redondo @franher